home *** CD-ROM | disk | FTP | other *** search
/ The Business Master (3rd Edition) / The Business Master (3rd Edition).iso / files / commadio / rcomm / rcomm.doc < prev    next >
Text File  |  1987-06-09  |  17KB  |  375 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6. RCOMM - Resident Communications  Version 1.0
  7. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  8.  
  9.                      Table of Contents
  10. Features............................................... 1
  11. Files Required......................................... 2
  12. Getting Started........................................ 3  
  13. Functions.............................................. 4
  14. Hotkey Explanation..................................... 6
  15. Technical Notes........................................ 7
  16. Disclaimer............................................. 8   
  17. Program Messages....................................... 9
  18. Other Stuff............................................10
  19.  
  20. RCOMM - Resident Communications  Version 1.0                         Page 1
  21. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  22.  
  23. This document relevant to release 1.0
  24.  
  25. Did you ever put off writing a letter or balancing your checkbook or doing
  26. a spreadsheet because you wanted to download a file from your favorite BBS?
  27. Me too. So I wrote this program and now you can do BOTH!
  28.  
  29. With RCOMM you can do memory resident uploads and downloads while 
  30. you do whatever you ought to be doing instead in the foreground.
  31.  
  32. Features include:
  33. *  Hayes or Novation Autocat modem dial commands. 
  34.       (I use an Autocat so I left my dial routines in.)
  35. *  Memory resident XMODEM (checksum or crc) and YMODEM batch upload.
  36. *  Memory resident XMODEM (checksum or crc) and YMODEM batch download.
  37. *  Memory resident XMODEM (checksum) autodownload as made popular by
  38.    -  EXEC-PC Multi-user BBS
  39.       Milwaukee, Wi. (414) 964-5160,
  40.    -  RYBBS,
  41.    -  and soon to be released (as I understand) as an extension to RBBS. 
  42. *  Pop-up terminal mode.
  43. *  PC-TALK compatible dialing directory.
  44. *  Not copy protected.
  45. *  Shareware. Try it out before you buy it.
  46.  
  47.  
  48. RCOMM - Resident Communications  Version 1.0                         Page 2
  49. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  50.  
  51. The following files and programs are required to run RCOMM.
  52. 1. RCOMM.COM - This is the main program.
  53.  
  54. 2. RCONFIG.EXE - Use this program to define certain default values.
  55.    These values include such things as:
  56.    a. Default baud rate, parity, etc.
  57.    b. Comm port.
  58.    c. Screen colors.
  59.       These are defined using the standard numbers defined by DOS and BASIC.
  60.       They are:
  61.       0 = Black, 1 = Blue, 2 = Green, 3 = Cyan, 4 = Red, 5 = Magenta,
  62.       6 = Brown, 7 = Light gray, 8 = Dark Gray, 9 = Light blue,
  63.       A = Light green, B = Light cyan, C = Light red, D = Light magenta,
  64.       E = Yellow, F = White. 
  65.    d. Modem initialization string.
  66.    e. Other miscellaneous stuff like whether sound should be on or off,
  67.       default path names for the configuration and dialing files, and
  68.       default autodownload path.
  69.  
  70.    This program creates a file called RCOMM.DAT which must reside in the
  71.    same directory as RCOMM.COM. I have included an RCOMM.DAT on the 
  72.    distribution disk which will at least let you get started. You should
  73.    really create your own configuration before doing too much though.
  74.  
  75. 3. RMAINT.EXE - This program is to be used for maintaining your dialing
  76.    directory. The dialing directory file is PC-TALK compatible, and in fact
  77.    is called PC-TALK.DIR. You may keep your dialing directory on any disk
  78.    or directory. The RCOMM.DAT file has an entry containing the pathname
  79.    of this file.
  80.  
  81. 4. RCOMM.DAT - As I mentioned above, this file is created by RCONFIG.EXE.
  82.    I have included a default file containing the following data.
  83.    For 2 floppy systems:
  84.    a. Hayes modem.
  85.    b. 1200 baud, 8 data bits, no parity, 1 stop bit, uses COM1 port.
  86.    c. Path for autodownload and Ymodem batch drive b:, no path.
  87.    d. No modem initialization string.
  88.    e. PC-TALK.DIR resides on drive a:.
  89.    f. Screen color is white on black.
  90.  
  91.    For hard disk systems:
  92.    a. Hayes modem.
  93.    b. 1200 baud, 8 data bits, no parity, 1 stop bit, uses COM1 port.
  94.    c. Path for autodownload and Ymodem batch c:\download
  95.    d. No modem initialization string.
  96.    e. PC-TALK.DIR resides on c:\rcomm.
  97.    f. Screen color is white on black.
  98.  
  99. 5. PC-TALK.DIR - I have included a PC-TALK.DIR just to get you started. If
  100.    you currently use PC-TALK, you should replace this file with your own. 
  101.  
  102.  
  103. RCOMM - Resident Communications  Version 1.0                         Page 3
  104. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  105.  
  106. Getting started.
  107.  
  108. *******************************************************************************
  109. 1. Your "CONFIG.SYS" file should contain extra files and buffers. I suggest:
  110.    "FILES=25" and "BUFFERS=25". This should be done because when RCOMM has
  111.    disk files open in the background there may not be enough file handles 
  112.    left for foreground tasks.
  113. *******************************************************************************
  114.  
  115. 2. If you have a two floppy system, insert the floppy containing the original
  116.    RCOMM files in drive a: and a blank formatted floppy in drive b:. Enter
  117.    "A:INSTALLF" and RCOMM will be installed on drive b:. You may want to run 
  118.    RCONFIG.EXE to change some default parameters first but it is not required.
  119.  
  120. 3. If you have a hard disk system, insert the floppy containing the original
  121.    RCOMM files in drive a: and enter "A:INSTALLH". This procedure will create
  122.    a sub-directory named "RCOMM" for the program files and another 
  123.    sub-directory named "DOWNLOAD". You can run RCOMM right away from the 
  124.    "RCOMM" directory. If you downloaded RCOMM right to your hard disk just
  125.    enter "INSTALLH" and it'll figure out what to do.
  126.  
  127. 4. Run RCOMM.COM and give your favorite BBS a buzz.
  128.  
  129. RCOMM - Resident Communications  Version 1.0                         Page 4
  130. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  131.  
  132. Terminal Function Keys:
  133.  
  134. <alt>-C - Clears the screen.
  135.  
  136. <alt>-D - Dial phone. 
  137.           The directory will be displayed on the screen. You may then select
  138.           an entry to be dialed. If you have call waiting, you will be given
  139.           the option to disable it. The string used to do this is "*70" for
  140.           touch tone or "1170" for pulse. This seems to be the standard
  141.           method. If dialing from the directory, the modem will be set up 
  142.           based on the directory. Otherwise the default settings will be used.
  143.          
  144. <alt>-H - Hang up phone.
  145.  
  146. <alt>-Q - Quick dial phone.
  147.           If you already know the record number of the entry you want to
  148.           dial you can use this function to bypass the directory display.
  149.  
  150. <alt>-R - Receive a file.
  151.           You will be prompted for what protocol to use. The following
  152.           protocols are available.
  153.           1. XMODEM checksum.
  154.              This is the most commonly used protocol. It consists of 128
  155.              byte blocks followed by a checksum character.
  156.           2. XMODEM CRC.
  157.              This is almost identical to XMODEM checksum except that each
  158.              128 byte block is followed by a 2 byte crc code.
  159.           3. YMODEM (batch).
  160.              This is basically XMODEM CRC with 1k blocks.
  161.              You may download more than one file at a time. The
  162.              sending system sends the filename in the first block of each
  163.              file. (Actually it sends a block number zero).
  164.  
  165.           If you selected protocol 1 or 2 you will be prompted for a
  166.           filename. 
  167.  
  168.           Enter FULL FILENAME including DRIVE, PATH and FILENAME.
  169.  
  170.           If you only enter a filename and then change drives while the
  171.           download is in process the result will not be a very pleasant sight.
  172.           Likewise if you remove the disk you are downloading to.
  173.           As soon as the initial handshaking is completed RCOMM will begin
  174.           displaying a status screen. To continue downloading in the 
  175.           background, just exit using the "ALT-X" function.
  176.           When the download is complete, RCOMM will emit a fairly high pitched
  177.           "beep" to let you know it is done. If downloading multiple files, 
  178.           there will be a "beep" after each file.
  179.  
  180. RCOMM - Resident Communications  Version 1.0                         Page 5
  181. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  182.  
  183.  
  184.           If you select YMODEM, or autodownload, the filename will be taken 
  185.           from the sending system. If you have specified a drive and pathname 
  186.           in the autodownload section of your config file, the filename will 
  187.           be appended to them. If not, the files will be placed into the 
  188.           current drive/directory. 
  189.  
  190. <alt>-T - Transmit a file.
  191.           You will be prompted for what protocol to use. The following
  192.           protocols are available.
  193.           1. XMODEM checksum.
  194.              This is the most commonly used protocol. It consists of 128
  195.              byte blocks followed by a checksum character.
  196.           2. XMODEM CRC.
  197.              This is almost identical to XMODEM checksum except that each
  198.              128 byte block is followed by a 2 byte crc code.
  199.           3. YMODEM (batch).
  200.              This is basically XMODEM CRC with 1k blocks. Wildcards are 
  201.              allowed if you want to send multiple files.
  202.  
  203.           You will then be prompted for a path/filename.
  204.  
  205.           Enter FULL FILENAME including DRIVE, PATH, and FILENAME.
  206.  
  207.           See <alt>R for the importance of entering all of this data. Like
  208.           <alt>R, this function also performs the file transfer in the back-
  209.           ground. 
  210.  
  211.           When the upload is complete, RCOMM will emit a fairly high pitched
  212.           "beep" to let you know it is done.
  213.  
  214.  
  215. <alt>-X - Exits to DOS. RCOMM will remain resident in memory.
  216.  
  217.  
  218.  
  219. RCOMM - Resident Communications  Version 1.0                         Page 6
  220. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  221.  
  222. Re-activating RCOMM:
  223.          Once RCOMM has been made resident you may re-activate it by hold-
  224.          ing the <right-shift> and <ctrl> keys down simultaneously. 
  225.    
  226.          Whatever application you are running in the foreground will
  227.          be saved and RCOMM will pop in.
  228.          
  229.          If there is a file transfer in progress RCOMM will display the file
  230.          name and buffer number, otherwise you will get the Ready... screen.
  231.  
  232.          When you are ready to "pop back out" to your foreground task use
  233.          the "<alt>-X" function. At this point, the foreground application 
  234.          will be reinstated.
  235.  
  236.  
  237. RCOMM - Resident Communications  Version 1.0                         Page 7
  238. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  239.  
  240. Technical notes:
  241. RCOMM has been tested as thoroughly as possible by the author and a few beta
  242. testers. The first few versions "blowed up real good" under certain 
  243. circumstances. These bugs have all been dealt with. One of my beta testers
  244. has a consistent problem bringing Framework up. This has been tried on several
  245. machines and only happens on his. Framework comes up alright but RCOMM is dead.
  246.  
  247. RCOMM has run successfully along with most major software packages, including
  248. other datacomm products on another port. If you encounter any incompatibility
  249. please notify me and I will try to resolve it in future releases.
  250.  
  251. ------
  252.  
  253.                       ==== NOTE ON HAYES MODEMS ====
  254. You should set switch 6 to the UP position on your hayes modem. RCOMM checks
  255. the carrier detect line to see if the phone has been answered.
  256.  
  257. ------
  258.  
  259. RCOMM uses the following interrupt vectors:
  260. 08h - Raw timer
  261. 21h - DOS function
  262. 28h - DOS idle
  263. 63h - User defined. 
  264.  
  265. RCOMM is a "well behaved" program. When it is finished with an interrupt, it
  266. passes control back to the previous owner. RCOMM should get along well with
  267. any foreground program as well as any other "well behaved" TSR's. 
  268.  
  269. RCOMM - Resident Communications  Version 1.0                         Page 8
  270. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  271.  
  272.         These programs are provided on an "as is" basis without warranty
  273.         of any kind, expressed or implied, including but not limited to
  274.         the implied warranties of merchantability and fitness for a par-
  275.         ticular purpose. The entire risk as to quality and performance of 
  276.         these programs is with you. Should the programs prove defective, 
  277.         you assume the entire cost of all necessary repair, servicing, or 
  278.         correction. In no event will the author be liable to you for any
  279.         damages, including any lost profits, lost savings, or other 
  280.         incidental or consequential damages arising out of the use of,
  281.         or inability to use this program. 
  282.  
  283. If you use this program and find it to be of value, your contribution would
  284. be appreciated. $25.00 is suggested. 
  285.  
  286. In any case these programs may be freely distributed as long as:
  287.     1. The copyright notices are not bypassed or altered.
  288.     2. All files and programs are included.
  289.        For release 1.0 this includes:
  290.        RCOMM.COM
  291.        RCONFIG.EXE
  292.        RMAINT.EXE    
  293.        RCOMM.DOC
  294.        RCOMM.DAF
  295.        RCOMM.DAH
  296.        INSTALLF.BAT
  297.        INSTALLH.BAT
  298.        PC-TALK.DIR
  299.        READ.ME    
  300.     3. No fee is charged for use, copying, or distribution.
  301.        (User groups and clubs may charge a reasonable fee for expenses
  302.        and handling.) 
  303.  
  304. Send contributions to:
  305. Thomas Duller
  306. P. O. Box 27095
  307. Milwaukee, WI. 53227
  308.  
  309. Please include a note telling me where you received RCOMM and what you would
  310. like to see in future releases.
  311.  
  312. Requests for enhancements will all be taken seriously, but keep in mind, I 
  313. just do this for fun. There will be future releases, but only when I get 
  314. around to it. This initial release was about two years in the making. 
  315. Hopefully, now that the hard part is done, the upgrades will come quicker.
  316.  
  317. Since I'm new to the Shareware biz I haven't decided how to distribute
  318. upgrades, but I reserve the right to charge a minor upgrade fee for postage
  319. and handling and whatever. Probably $5.00 or so. 
  320.  
  321. You may also contact me though EXEC-PC Multi-user BBS (414)-964-5160 (user
  322. name "Tom Duller").    
  323.  
  324. RCOMM - Resident Communications  Version 1.0                         Page 9
  325. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  326.  
  327. Most messages displayed by RCOMM are self explanatory, there are a few that
  328. bear further explanation.
  329.  
  330. Message: RCOMM already resident - use <right shift>/<ctrl> to activate.
  331. Reason:  You are trying to start RCOMM and it has already been installed.
  332. Action:  Use the <right shift>/<ctrl> hotkey to pop it up.
  333.  
  334. Message: File RCOMM.DAT not found on current drive or directory. 
  335.          Run RCONFIG.EXE to create.
  336. Reason:  When loading, RCOMM couldn't find it's default file.
  337. Action:  Either load RCOMM.DAT to the current drive/path or run RCONFIG.EXE
  338.          to set defaults.
  339.  
  340. Message: Dialing directory file not found on specified path.
  341.          You may dial manually.
  342. Reason:  The phone directory isn't where RCOMM.DAT says it should be.
  343. Action:  Either 1. Exit and copy it to where it should be or
  344.                 2. Enter the number by hand.
  345.  
  346. Message: Enter path/filename : 
  347. Reason:  You are going to up/download a file using a non-batch protocol.
  348. Action:  While this may seem to be a simple enough question, keep in mind that
  349.          you *must* enter drive,path,*and* filename.
  350.          The reason for this is explained in detail on page 4 under the 
  351.          <alt-r> command.
  352.      
  353. RCOMM - Resident Communications  Version 1.0                         Page 10
  354. Copyright (c) 1986, 1987  by Thomas Duller, All rights reserved.
  355.  
  356. You may notice that background uploading with any protocol seems a little
  357. slow. The reason for this is that a happy medium must be struck between the
  358. upload and the foreground application. If the upload was to go full blast the
  359. foreground task would be hopelessly sluggish. The result is that a 1200 baud
  360. upload really goes at about 800 baud when in the background. If RCOMM is in
  361. the foreground uploading goes at full speed. The slow background upload could
  362. be considered a nice feature when uploading to BBS's which give credit for
  363. upload time (grin).
  364. Downloads run at the same speed whether background or foreground because in-
  365. coming characters are buffered and handled in large chunks.
  366.  
  367. There is another feature which I didn't put in the regular documentation be-
  368. cause it's a little risky. Ymodem-G batch is also supported. When beginning
  369. a transfer you can use it by hitting "4" at the protocol prompt. It's not
  370. one of the listed options, but it works. In the foreground, there are no 
  371. problems at all. In the background, uploading works fine, but if you
  372. try to use Ymodem-G for background downloading there is a VERY good chance
  373. that the datacomm buffer will overflow and your computer will lock up. Use
  374. it if you want to, but don't complain to me when you have to boot out of it.
  375.